<!DOCTYPE html>
<html lang="en">
    <head>
        <meta charset="utf-8">
        <meta http-equiv="X-UA-Compatible" content="IE=edge">
        <meta name="viewport" content="width=device-width, initial-scale=1.0">
        <meta name="description" content="None">
        
        
        <link rel="shortcut icon" href="img/favicon.ico">
        <title>My Docs</title>
        <link href="css/bootstrap.min.css" rel="stylesheet">
        <link href="css/font-awesome.min.css" rel="stylesheet">
        <link href="css/base.css" rel="stylesheet">
        <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css">

        <script src="js/jquery-1.10.2.min.js" defer></script>
        <script src="js/bootstrap.min.js" defer></script>
        <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
        <script>hljs.initHighlightingOnLoad();</script> 
    </head>

    <body class="homepage">
        <div class="navbar fixed-top navbar-expand-lg navbar-dark bg-primary">
            <div class="container">
                <a class="navbar-brand" href=".">My Docs</a>
                <!-- Expander button -->
                <button type="button" class="navbar-toggler" data-toggle="collapse" data-target="#navbar-collapse">
                    <span class="navbar-toggler-icon"></span>
                </button>

                <!-- Expanded navigation -->
                <div id="navbar-collapse" class="navbar-collapse collapse">
                        <!-- Main navigation -->
                        <ul class="nav navbar-nav">
                            <li class="navitem active">
                                <a href="." class="nav-link">Pygame Widgets</a>
                            </li>
                            <li class="navitem">
                                <a href="animations/" class="nav-link">Animations</a>
                            </li>
                            <li class="navitem">
                                <a href="button/" class="nav-link">Button</a>
                            </li>
                            <li class="navitem">
                                <a href="buttonarray/" class="nav-link">ButtonArray</a>
                            </li>
                            <li class="navitem">
                                <a href="combobox/" class="nav-link">ComboBox</a>
                            </li>
                            <li class="navitem">
                                <a href="common/" class="nav-link">Common</a>
                            </li>
                            <li class="navitem">
                                <a href="dropdown/" class="nav-link">Dropdown</a>
                            </li>
                            <li class="navitem">
                                <a href="progressbar/" class="nav-link">Progress Bar</a>
                            </li>
                            <li class="navitem">
                                <a href="slider/" class="nav-link">Slider</a>
                            </li>
                            <li class="navitem">
                                <a href="textbox/" class="nav-link">TextBox</a>
                            </li>
                            <li class="navitem">
                                <a href="toggle/" class="nav-link">Toggle</a>
                            </li>
                        </ul>

                    <ul class="nav navbar-nav ml-auto">
                        <li class="nav-item">
                            <a href="#" class="nav-link" data-toggle="modal" data-target="#mkdocs_search_modal">
                                <i class="fa fa-search"></i> Search
                            </a>
                        </li>
                            <li class="nav-item">
                                <a rel="prev" class="nav-link disabled">
                                    <i class="fa fa-arrow-left"></i> Previous
                                </a>
                            </li>
                            <li class="nav-item">
                                <a rel="next" href="animations/" class="nav-link">
                                    Next <i class="fa fa-arrow-right"></i>
                                </a>
                            </li>
                    </ul>
                </div>
            </div>
        </div>

        <div class="container">
            <div class="row">
                    <div class="col-md-3"><div class="navbar-light navbar-expand-md bs-sidebar hidden-print affix" role="complementary">
    <div class="navbar-header">
        <button type="button" class="navbar-toggler collapsed" data-toggle="collapse" data-target="#toc-collapse" title="Table of Contents">
            <span class="fa fa-angle-down"></span>
        </button>
    </div>

    
    <div id="toc-collapse" class="navbar-collapse collapse card bg-secondary">
        <ul class="nav flex-column">
            
            <li class="nav-item" data-level="1"><a href="#pygame-widgets" class="nav-link">Pygame Widgets</a>
              <ul class="nav flex-column">
            <li class="nav-item" data-level="2"><a href="#prerequisites" class="nav-link">Prerequisites</a>
              <ul class="nav flex-column">
              </ul>
            </li>
            <li class="nav-item" data-level="2"><a href="#installation" class="nav-link">Installation</a>
              <ul class="nav flex-column">
              </ul>
            </li>
            <li class="nav-item" data-level="2"><a href="#usage" class="nav-link">Usage</a>
              <ul class="nav flex-column">
              </ul>
            </li>
            <li class="nav-item" data-level="2"><a href="#how-to-contribute" class="nav-link">How to Contribute</a>
              <ul class="nav flex-column">
              </ul>
            </li>
              </ul>
            </li>
        </ul>
    </div>
</div></div>
                    <div class="col-md-9" role="main">

<h1 id="pygame-widgets">Pygame Widgets</h1>
<p><img alt="" src="https://img.shields.io/pypi/dm/pygame-widgets" /></p>
<p>A helper module for common widgets that may be required in developing applications with Pygame.</p>
<h2 id="prerequisites">Prerequisites</h2>
<ul>
<li><a href="https://www.python.org/downloads">Python 3</a> <code>&gt;= 3.7</code></li>
<li><a href="https://www.pygame.org/wiki/GettingStarted">Pygame</a> <code>&gt;= 2.0.0</code></li>
</ul>
<h2 id="installation">Installation</h2>
<p>Ensure that Python 3 and pip are installed and added to your environment PATH.</p>
<p><code>python -m pip install pygame-widgets</code></p>
<p>Open a Python console and run the following command.</p>
<p><code>import pygame_widgets</code></p>
<p>If you receive no errors, the installation was successful.</p>
<h2 id="usage">Usage</h2>
<ul>
<li><a href="docs/common.md">Common</a></li>
<li><a href="docs/button.md">Button</a></li>
<li><a href="docs/buttonarray.md">ButtonArray</a></li>
<li><a href="docs/textbox.md">TextBox</a></li>
<li><a href="docs/slider.md">Slider</a></li>
<li><a href="docs/toggle.md">Toggle</a></li>
<li><a href="docs/progressbar.md">ProgressBar</a></li>
<li><a href="docs/dropdown.md">Dropdown</a></li>
<li><a href="docs/combobox.md">ComboBox</a></li>
<li><a href="docs/animations.md">Animations</a></li>
</ul>
<h2 id="how-to-contribute">How to Contribute</h2>
<p>Any contribution to this project would be greatly appreciated.
This can include:</p>
<ul>
<li>Finding errors or bugs and creating a new issue</li>
<li>Addressing active issues</li>
<li>Adding functionality</li>
<li>Improving documentation</li>
</ul>
<p>If applicable, you should make any changes in a forked repository and then create a pull
request once the changes are <strong><em>complete</em></strong> and preferably tested if possible.</p>
<p><em>Note: If writing any code, please attempt to follow the <a href="CONTRIBUTING.md">Code Style Guide</a></em></p></div>
            </div>
        </div>

        <footer class="col-md-12">
            <hr>
            <p>Documentation built with <a href="https://www.mkdocs.org/">MkDocs</a>.</p>
        </footer>
        <script>
            var base_url = ".",
                shortcuts = {"help": 191, "next": 78, "previous": 80, "search": 83};
        </script>
        <script src="js/base.js" defer></script>
        <script src="search/main.js" defer></script>

        <div class="modal" id="mkdocs_search_modal" tabindex="-1" role="dialog" aria-labelledby="searchModalLabel" aria-hidden="true">
    <div class="modal-dialog modal-lg">
        <div class="modal-content">
            <div class="modal-header">
                <h4 class="modal-title" id="searchModalLabel">Search</h4>
                <button type="button" class="close" data-dismiss="modal"><span aria-hidden="true">&times;</span><span class="sr-only">Close</span></button>
            </div>
            <div class="modal-body">
                <p>From here you can search these documents. Enter your search terms below.</p>
                <form>
                    <div class="form-group">
                        <input type="search" class="form-control" placeholder="Search..." id="mkdocs-search-query" title="Type search term here">
                    </div>
                </form>
                <div id="mkdocs-search-results" data-no-results-text="No results found"></div>
            </div>
            <div class="modal-footer">
            </div>
        </div>
    </div>
</div><div class="modal" id="mkdocs_keyboard_modal" tabindex="-1" role="dialog" aria-labelledby="keyboardModalLabel" aria-hidden="true">
    <div class="modal-dialog">
        <div class="modal-content">
            <div class="modal-header">
                <h4 class="modal-title" id="keyboardModalLabel">Keyboard Shortcuts</h4>
                <button type="button" class="close" data-dismiss="modal"><span aria-hidden="true">&times;</span><span class="sr-only">Close</span></button>
            </div>
            <div class="modal-body">
              <table class="table">
                <thead>
                  <tr>
                    <th style="width: 20%;">Keys</th>
                    <th>Action</th>
                  </tr>
                </thead>
                <tbody>
                  <tr>
                    <td class="help shortcut"><kbd>?</kbd></td>
                    <td>Open this help</td>
                  </tr>
                  <tr>
                    <td class="next shortcut"><kbd>n</kbd></td>
                    <td>Next page</td>
                  </tr>
                  <tr>
                    <td class="prev shortcut"><kbd>p</kbd></td>
                    <td>Previous page</td>
                  </tr>
                  <tr>
                    <td class="search shortcut"><kbd>s</kbd></td>
                    <td>Search</td>
                  </tr>
                </tbody>
              </table>
            </div>
            <div class="modal-footer">
            </div>
        </div>
    </div>
</div>

    </body>
</html>

<!--
MkDocs version : 1.2.2
Build Date UTC : 2021-07-31 04:39:51.954389+00:00
-->
